Skip to content

docs: add AI coding agent instructions (CLAUDE.md + AGENTS.md)#3

Merged
YASoftwareDev merged 3 commits intomainfrom
docs/add-ai-agent-instructions
Apr 19, 2026
Merged

docs: add AI coding agent instructions (CLAUDE.md + AGENTS.md)#3
YASoftwareDev merged 3 commits intomainfrom
docs/add-ai-agent-instructions

Conversation

@YASoftwareDev
Copy link
Copy Markdown
Contributor

@YASoftwareDev YASoftwareDev commented Apr 18, 2026

Summary

Adds `CLAUDE.md` and `AGENTS.md` with repo-specific guidance for AI coding agents.

Also bumps version to `1.1.4+1` (build-metadata increment — proto API unchanged)
and adds the corresponding `CHANGELOG.md` entry noting alignment with
`asr-api v1.1.1+1`.

Convention adopted

  • `CLAUDE.md` — full repo-specific content (Claude Code's auto-loaded file).
  • `AGENTS.md` — `See CLAUDE.md` redirect (cross-tool standard for Codex / Cursor / Aider).

What was researched

  • `README.md`, `pyproject.toml`, `setup.py`, `.gitignore`, `VERSION.md`, `CHANGELOG.md`
  • `proto/` tree and `asr_api/` alias modules
  • Confirmed `submodules/asr-api/` is NOT a git submodule (no `.gitmodules`); proto files vendored directly under `proto/`

Sections intentionally omitted

  • `setup.sh` / `install.sh` — repo doesn't have them; documented as such.
  • CI / tests / lint — none defined.

Verifying

```bash
python3 -m venv .venv && source .venv/bin/activate
pip install --require-virtualenv --upgrade pip
pip install --require-virtualenv .
python -c "from asr_api import v1p1 as api; assert hasattr(api, 'StreamingRecognizeRequest')"
```

Wojciech Pędzimąż added 3 commits April 18, 2026 12:02
Document repo-specific conventions: stock-pip install (no setup.sh/install.sh
split here), grpc_tools.protoc invocation in setup.py, the gitignored
google/ and techmo/ output dirs that must never be committed, and the
dependency pins that constrain the protobuf-4 compatibility surface.
Records the AI coding agent instructions PR in CHANGELOG.md, advances
VERSION.md and asr_api/VERSION.py to 1.1.4+1 (build-metadata increment —
proto API unchanged), and notes alignment with asr-api v1.1.1+1.
Resolve conflicts:
- CHANGELOG.md: prepend 1.1.4+1 entry above incoming 1.1.4 history
- asr_api/VERSION.py: keep 1.1.4+1
- VERSION.md: accept deletion (main removed it; version now in VERSION.py only)
- submodules/asr-api: advance pointer from v1.1.1 to v1.1.1+1
@YASoftwareDev YASoftwareDev merged commit a8c9f5e into main Apr 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant